Inside Macintosh: QuickDraw GX Objects /

Chapter 5 - Ink Objects / Ink Objects Reference

Functions / Getting and Setting an Ink's Color

GXGetInkColor

You can use the GXGetInkColor function to examine the color of an ink object.

gxColor *GXGetInkColor(gxInk source, gxColor *data);

source

A reference to the ink whose color you want.

data

A pointer to a color structure. On return, the structure contains the color of the ink object.

function result

The color of the source ink object.

DESCRIPTION

The GXGetInkColor function returns, as its function result and in the structure pointed to by the data parameter, the color of the ink referenced in the source parameter.

If the ink object reference or the pointer to the color structure is nil, an error is posted, and nil is returned as the function result.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
ink_is_nil
color_is_nil

SEE ALSO

Ink colors are introduced in the section "Color" beginning on page 5-7, and described fully in the chapter "Colors and Color-Related Objects" in this book.

To assign a color to an ink object, use the GXSetInkColor function, described next.

To examine the color of the ink object associated with a shape, use the GXGetShapeColor function, described on page 5-70.